/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.platformservice.messaging;

import org.proteusframework.core.api.model.IMetadata;
import org.proteusframework.platformservice.persistence.api.messagebean.IMessageBeanDescriptor;

/**
 * Root interface of all {@link IMessageSink} messages.
 *
 * @param <E> Type of physical message bean, e.g. a POJO, that this message bean wraps.
 */
public interface IMessageBean<E> extends IMetadata
{
    /**
     * Convenience method for accessing the descriptor of the underlying message bean represented by E.
     *
     * @return Message bean descriptor
     */
    IMessageBeanDescriptor getDescriptor();

    /**
     * Retrieves the underlying message bean itself.
     *
     * @return Message bean
     */
    E getBean();


}
